home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr37 / qlogin06.zip / QLOGIN.DOC < prev    next >
Text File  |  1994-10-16  |  8KB  |  170 lines
  1. ┌─────────────────────────────────────────────────────────────────────────────┐
  2. │         ┌──────┐ ┌─┐    ┌──────┐ ┌──────┐ ┌───┐ ┌───┐  ┌─┐                  │
  3. │         │ ┌──┐ │ │ │    │ ┌──┐ │ │ ┌────┘ └┐ ┌┘ │   └┐ │ │                  │
  4. │         │ │  │ │ │ │    │ │  │ │ │ │ ┌──┐  │ │  │ ├┐ └┐│ │                  │
  5. │         │ │  │ │ │ │    │ │  │ │ │ │ └┐ │  │ │  │ │└┐ └┤ │                  │
  6. │         │ └──┘ │ │ └──┐ │ └──┘ │ │ └──┘ │ ┌┘ └┐ │ │ └┐   │                  │
  7. │         └───┐ ┌┘ └────┘ └──────┘ └──────┘ └───┘ └─┘  └───┘v0.60ß            │
  8. │             ┴─┴ The ≡FAST≡ Login Utility for ProBoard 2.x                   │
  9. │                Another Fine HomeGrown Pex. (C)1994 G.Smith                  │
  10. │                                                                             │
  11. └─────────────────────────────────────────────────────────────────────────────┘
  12. What is QLOGIN?
  13. ===============
  14. QLOGIN is a utility to allow your users to bypass one-liners, news
  15. screens etc and go straight to the main menu. It is written in such a
  16. way that you can make all of your most used options available from the
  17. QLOGIN menu.
  18.  
  19. Installation
  20. =============
  21. 1. Edit the QLOGIN.INI file to configure your QLOGIN menu. The QLOGIN.INI
  22. file is well commented, so just follow the instructions within that
  23. file. Once you have finished editing, copy the QLOGIN.INI file into your
  24. \PROBOARD\PEX directory. QLOGIN will check your system path, and expect
  25. to find QLOGIN.INI in a directory called PEX, just below your main
  26. proboard directory.
  27.  
  28. 2. Edit QLOGIN.ANS/ASC to match the configuration settings in
  29. QLOGIN.INI. QLOGIN will expect to find the QLOGIN.ANS/QLOGIN.ASC files
  30. in the TEXTFILES directory which is set in PROCFG - Options|Paths.
  31. Take not of the position (Column ,Row) of your selection prompt. You need
  32. these co-ordinates to correctly set the cursor position on the menu
  33. screen. If you intend to have a separate sysop menu, edit QSYSOP.ANS/ASC
  34. to match the additional 'sysop only' configuration settings in
  35. QLOGIN.INI
  36.  
  37. 3. Rename QLOGIN.PEX to WELCOME1.PEX and place it in your PEX directory.
  38.  
  39. 4. If you have any files such as NEWS.* that you wish only to be
  40. shown/executed during a 'Normal' login, rename them to something else
  41. and set them up in the Action options in QLOGIN.INI.
  42.  
  43. eg.. rename NEWS.* to DBNEWS.* / rename welcome2.pex to qlogin2.pex
  44.  
  45. Configuration Keywords
  46. ======================
  47.  
  48. SysopLevel - The inclusion of this setting causes QLOGIN to look for
  49.              (and expect to find) an additional menu screen called
  50.              QSYSOP.A?? in Proboard's textfiles directory. This
  51.              additional screen will only be shown to those with a
  52.              security level equal to or greater that the SysopLevel.
  53.  
  54.         eg. SysopLevel = 32000
  55.  
  56.  
  57. CursorX
  58. CursorY    - These settings determine the position of the cursor on the
  59.              menu (ans/avt) screen. When designing your screen, take
  60.              note of the position of your 'Choice:' prompt. CursorX is
  61.              the column number, and CursorY is the line number.
  62.  
  63.         eg. CursorX = 5   <-  5 characters in from left of screen
  64.             CursorY = 20  <-  20 lines down from top of screen
  65.  
  66.  
  67. MenuOptionCount
  68. ActionCount     - These settings reflect the number of menuOptions and
  69.                   Actions you have set. Be very careful with these. If
  70.                   you have 5 menu options, and the MenuOptionCount is
  71.                   set to 4, the 5th option will _not_ work. This setting
  72.                   was added to enhance speed. Rather than searching for
  73.                   20 menuOptions every time, QLOGIN will only look for
  74.                   the number in this setting.
  75.  
  76.         eg. MenuOptionCount = 9
  77.             ActionCount = 5
  78.  
  79.  
  80. MenuOption(n)   - You may have up to 20 menu options. These menu options
  81.                   should be numbered in sequence ie MenuOption1,
  82.                   MenuOption2 .. MenuOption20. If you only have 5 menu
  83.                   options, then just use MenuOption1 .. MenuOption5.
  84.                   This setting is the type of menu function. It takes a
  85.                   menu command number as a parameter. The menu command
  86.                   numbers are the same as those in PROCFG|Menu Editor.
  87.  
  88.         eg. MenuOption1 = 37 <- Menu option number (same as in PROCFG)
  89.                                 This one is '37 - Show New Files'
  90.  
  91.  
  92. MenuOption(n)_Key - This is the hotkey for a specific menu function.
  93.  
  94.         eg. MenuOption1_Key = -N  <- This is the 'hotkey' for this option (N)
  95.                                      MUST be preceded by a '-' minus sign.
  96.  
  97.  
  98. MenuOption(n)_Data - This is the accompanying data for a menu function.
  99.                      The format/options are the same as in PROCFG|Menu
  100.                      Editor.
  101.  
  102.         eg. MenuOption1_Data = * -C  <- additional data for this menu option.
  103.                                        Same format as menu data field in PROCFG
  104.  
  105.  
  106. MenuOption(n)_Level - This setting determines the minimum security level
  107.                       required in order to access this menu option.
  108.  
  109.         eg. MenuOption1_Level = 5   <- Min. Security level required in
  110.                                          order to use this feature. (same
  111.                                          levels as in PROCFG). If you do not
  112.                                          use the MenuOption(n)_Level settings,
  113.                                          they default to 0.
  114.  
  115. Action(n)  - This setting works the same as the MenuOption(n) setting.
  116.              The parameter is a menu function number. The actions are
  117.              executed if a user selects the normal login. You may define
  118.              up to 10 actions, numbered sequentially from Action1 ..
  119.              Action10.
  120.  
  121. Action(n)_Data - This is the accompanying data for the specific action
  122.                  such as the name of a *.ans/*.asc file in the case of
  123.                  an Action(n) = 5 (Show *.ANS/*.ASC File), or the name
  124.                  of a pex file in the case of Action(n) = 60.
  125.  
  126.         eg. Action1 = 5
  127.             Action1_Data = DBNEWS <- *.ANS/*.ASC File name
  128.  
  129. Action(n)_Level - This is the minimum security level required for the
  130.                   user to 'see' this action when he chooses a normal
  131.                   login.
  132.  
  133.  
  134. Comments
  135. ========
  136. As this is a beta, I am particularly interested in getting feedback
  137. regarding any problems you may have, or any suggestions for
  138. improvements. I am aware that there are several menu options that won't
  139. work in the MenuOption section of QLOGIN. I'm not sure if this is a
  140. program 'bug' as such, or simply not possible at that stage of the login
  141. sequence. As an example, it is not possible to execute a 'Goto Menu' or
  142. 'Gosub Menu' function. I have not yet tested all menu functions, but
  143. will compile a list of available options/numbers at a later stage.
  144.  
  145. Copyright Notice
  146. ----------------
  147.  
  148. QLOGIN is 'donorware'. You are under no obligation to pay for this
  149. program, but are welcome to send a donation of $US10 to keep the
  150. author's spirits up..:) Feedback and any donations will help to ensure
  151. the continued development of QLOGIN. I have several additional features
  152. planned and will be very receptive to any other suggestions.
  153. The author will take no responsibility for any damage that may be caused
  154. by the use, proper or improper, of this program. The only guarantee given
  155. is that it will use some hard disk space.
  156.  
  157. Contacting the Author
  158. ---------------------
  159. BBS: DataBus/2                 Fidonet:  3:637/103    AceNet: 133:666/15
  160.      Ph. +61-53-362-775        TriNet : 42:8699/51
  161.      24hrs  V.FC
  162.  
  163. Internet: gsmith@nova.ballarat.edu.au
  164.  
  165. Snail Mail:   Gary Smith,
  166.               P.O. Box 192,
  167.               Sebastopol,
  168.               Vic.   3356
  169.               Australia
  170.